Fixed naive doc formatting for #[must_use] lints
#7827
Conversation
|
r? @xFrednet (rust-highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
the
S-waiting-on-review
| /// | ||
| /// ### Why is this bad? | ||
| /// It's better to explicitly |
There was a problem hiding this comment.
Hey, most of these doc comments intentionally use an extra link for must_use. These comments are exported and rendered on Clippy's lint list which doesn't automatically lint to Rust's attributes and symbols. Therefore, it wouldn't be good to change it in the lint documentation.
This adjustment is correct, though. Could you revert, the other changes and add a link for the attributes in this lint documentation? 🙃
There was a problem hiding this comment.
Sorry, but I don't quite understand you. For me this website looks so (screenshot from the must_use_candidate lint):
Is this here shown behaviour really the desired one? I started this PR to get the outer [] away and when I looked more closely I saw that this "link" doesn't actual work, so I removed it too. Was this wrong?
There was a problem hiding this comment.
Interesting, I believe that GH actually accepts code like that. Let's see [#[must_use]]
[#[must_use]]: https://doc.rust-lang.org/reference/attributes/diagnostics.html#the-must_use-attribute
Apparently not, TIL. I thought that markdown would accept that, but apparently it doesn't. This makes a lot more sense now. Thank you for checking 🙃
|
Thank you for the update 👍 @bors r+ |
|
📌 Commit 25ff7ce has been approved by |
|
☀️ Test successful - checks-action_dev_test, checks-action_remark_test, checks-action_test |
The documentation of a few lints around the
#[must_use]attribute had a few times "[#[must_use]]" (without the parentheses, but with the[]) and once the "`" was missing.changelog: Fixed naive doc formatting for
#[must_use]lints ([must_use_unit], [double_must_use], [must_use_candidate], [let_underscore_must_use])